Pro-Cloud API Web Service
Method/ProCloudWS.asmx/ManifestingServiceUserSearch
Pro-Cloud API Web Service > All Operations Resource Group : /ProCloudWS.asmx/ManifestingServiceUserSearch (Method)
Description
This web method returns a list of service users, the service user ID and default address ID are both used within the ordering process
Request (ManifestingServiceUserSearchSoapIn)

The request body is of type ManifestingServiceUserSearch.

Request Body Parameters

NameDescriptionData Type
objProviderGUId

This is a unique provider id, which can be obtained from CSS

GUId

guid
strPassword

This is your unique service password which can be obtained from CSS

String (min 1 max 50)

xml:string
intProviderBranchID

This is to filter by a particular branch ID

Int (using 0 will return results for all branches)

xml:int
strSurname

This is the service user Surname

String (min 1 max 75)

xml:string
strForename

This is the service user Forename

String (min 1 max 75)

xml:string
dDOB

This is the service user date of birth

DateTime (DD/MM/YYYY)

xml:dateTime
strBuildingNameNumber

The house number or name of the service user default address

String (min 1 max 100)

xml:string
strPostcode

The postcode of the service user default address

String (min 1 max 11)

xml:string
strStreetTown

The street or town of the service user default address

String (min 1 max 120)

xml:string
intActivityID

A ProCloud activity ID for an activity assigned to the service user

Int

xml:int
strPurchaseOrderIdentifier

A ProCloud Purchase Order reference for an activity assigned to the service user

varchar (min 1 max 50)

xml:string
strLegacyOrderNo

A legacy order number for an activity assigned to the service user

varchar (min 1 max 30)

xml:string
strOrganisationName

Business name to search if performing a business lookup

String (min 1 max 30)

xml:string
booBusinessSearch

Flag to indicate if search should query service users or businesses

Bool

xml:boolean
intUserId

The user performing the search (Optional)

int

xml:int
intPageThe page of results to display
int		xml:int
intItemsPerPage

The number of search results to display per page

int

xml:int
intPrescriberTeamId

The prescriber team that the service user belongs to (Optional)

int

xml:int
intPrescriberTeamId Element intItemsPerPage Element intPage Element intUserId Element booBusinessSearch Element strOrganisationName Element strLegacyOrderNo Element strPurchaseOrderIdentifier Element intActivityID Element strStreetTown Element strPostcode Element strBuildingNameNumber Element dDOB Element strForename Element strSurname Element intProviderBranchID Element strPassword Element objProviderGUId Element Sequence ManifestingServiceUserSearch Element

Overview

ManifestingServiceUserSearch
Sequence
objProviderGUId guid Simple Type
strPassword optional xs:string
intProviderBranchID xs:int
strSurname optional xs:string
strForename optional xs:string
dDOB xs:dateTime
strBuildingNameNumber optional xs:string
strPostcode optional xs:string
strStreetTown optional xs:string
intActivityID xs:int
strPurchaseOrderIdentifier optional xs:string
strLegacyOrderNo optional xs:string
strOrganisationName optional xs:string
booBusinessSearch xs:boolean
intUserId xs:int
intPage xs:int
intItemsPerPage xs:int
intPrescriberTeamId xs:int
Response (ManifestingServiceUserSearchSoapOut)

The response body is of type ManifestingServiceUserSearchResponse.

Response Body Parameters

NameDescriptionData Type
ManifestingServiceUserSearchResult objManifestingServiceUserSearch
xmlDataSet Element strErrorMsg Element intErrorId Element Sequence ManifestingServiceUserSearchResult Element Sequence ManifestingServiceUserSearchResponse Element

Overview

ManifestingServiceUserSearchResponse
Sequence
Example
<?xml version="1.0" encoding="UTF-8"?>
<objManifestingServiceUserSearch xmlns="http://pro-cloud.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<intErrorId>0</intErrorId>
	<strErrorMsg/>
	<xmlDataSet>
		<NewDataSet xmlns="">
			<Pagination>
				<Page>1</Page>
				<Items>11</Items>
				<Pages>1</Pages>
			</Pagination>
			<Result>
				<idseed>1</idseed>
				<ServiceUserGUId>3783c70b-4671-4ec8-ab0f-194b40e6d558</ServiceUserGUId>
				<ServiceUserId>154306</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>111111</Forename>
				<Surname>111111</Surname>
				<ServiceUserName> 111111 111111</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>111111 111111 111111 111111</ServiceUserAddress>
				<DefaultAddressUId>163252</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
			<Result>
				<idseed>2</idseed>
				<ServiceUserGUId>39fe75fc-2864-4dfc-a9c7-342e51083c62</ServiceUserGUId>
				<ServiceUserId>154307</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>ababababab</Forename>
				<Surname>ababababab</Surname>
				<ServiceUserName> ababababab ababababab</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>ababababab ababababab ababababab ababababab</ServiceUserAddress>
				<DefaultAddressUId>163254</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
			<Result>
				<idseed>3</idseed>
				<ServiceUserGUId>17aff6f5-5a7c-48f0-b125-a7034eda2176</ServiceUserGUId>
				<ServiceUserId>154285</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>Example Company</Forename>
				<Surname>Admin 2</Surname>
				<ServiceUserName>Admin 2</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>Example Address T10 PAA</ServiceUserAddress>
				<DefaultAddressUId>163204</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
			<Result>
				<idseed>4</idseed>
				<ServiceUserGUId>e403f91a-87ed-4dca-bebd-9c26c3fba2bb</ServiceUserGUId>
				<ServiceUserId>154286</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>Tony</Forename>
				<Surname>Bennett</Surname>
				<ServiceUserName> Tony Bennett</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>18 Forrell Grove Birmingham B31 4SN</ServiceUserAddress>
				<DefaultAddressUId>163208</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
			<Result>
				<idseed>5</idseed>
				<ServiceUserGUId>2d02b9ae-8895-4da1-87b8-afce1cc8e5ff</ServiceUserGUId>
				<ServiceUserId>154305</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>Jo</Forename>
				<Surname>Blogs</Surname>
				<ServiceUserName> Jo Blogs</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>parkside court, building 3 greenhough road lichfield WS13 7AU</ServiceUserAddress>
				<DefaultAddressUId>163251</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
			<Result>
				<idseed>6</idseed>
				<ServiceUserGUId>5947dc3a-4884-4118-9ab6-a368ccd75498</ServiceUserGUId>
				<ServiceUserId>154308</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>cfcfcf</Forename>
				<Surname>cfcfcf</Surname>
				<ServiceUserName> cfcfcf cfcfcf</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>cfcfcf cfcfcf cfcfcf cfcfcf</ServiceUserAddress>
				<DefaultAddressUId>163255</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
			<Result>
				<idseed>7</idseed>
				<ServiceUserGUId>ccb4c57b-31de-4f6d-b723-50ccb0948293</ServiceUserGUId>
				<ServiceUserId>154299</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>John 5965</Forename>
				<Surname>Smith 5965</Surname>
				<ServiceUserName> John 5965 Smith 5965</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>parkside court, builing 3 greenhough road lichfield WS13 7AU</ServiceUserAddress>
				<DefaultAddressUId>163240</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
			<Result>
				<idseed>8</idseed>
				<ServiceUserGUId>7bf0b933-f9ea-4cd9-865e-6a3b013d0534</ServiceUserGUId>
				<ServiceUserId>154283</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>Creative</Forename>
				<Surname>Software Solutions Ltd.</Surname>
				<ServiceUserName> Creative Software Solutions Ltd.</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>3 Greenhough Road Lichfield WS13 7AU</ServiceUserAddress>
				<DefaultAddressUId>163137</DefaultAddressUId>
				<NHSNICMSCMH>//0/</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>11</OrganisationId>
				<OrganisationName>Creative Software Solutions Ltd.</OrganisationName>
			</Result>
			<Result>
				<idseed>9</idseed>
				<ServiceUserGUId>99bcea22-9c0e-4f5d-994f-e26687502e3c</ServiceUserGUId>
				<ServiceUserId>154284</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>Example</Forename>
				<Surname>User 5</Surname>
				<ServiceUserName> Example User 5</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>T- Place London S1A 1AP</ServiceUserAddress>
				<DefaultAddressUId>163204</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
			<Result>
				<idseed>10</idseed>
				<ServiceUserGUId>a4c01148-ce01-4aa7-8235-087e36d0ce21</ServiceUserGUId>
				<ServiceUserId>154303</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>123423532532</Forename>
				<Surname>WIL45345234534534535SON</Surname>
				<ServiceUserName> 123423532532 WIL45345234534534535SON</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>334534534538 a Road Rugey 3453535</ServiceUserAddress>
				<DefaultAddressUId>163247</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
			<Result>
				<idseed>11</idseed>
				<ServiceUserGUId>212133f8-5b75-4b91-89cd-bef0070fc0f5</ServiceUserGUId>
				<ServiceUserId>154302</ServiceUserId>
				<ContractId>60</ContractId>
				<ContractGuid>04d81168-0fe0-4e02-9c70-45d722302638</ContractGuid>
				<ContractName>Example Company</ContractName>
				<Forename>Matt</Forename>
				<Surname>WILSON</Surname>
				<ServiceUserName> Matt WILSON</ServiceUserName>
				<Gender>U</Gender>
				<DOB>01/01/2999</DOB>
				<ServiceUserAddress>17 Wharf Road Rugeley WS151BL</ServiceUserAddress>
				<DefaultAddressUId>163243</DefaultAddressUId>
				<NHSNICMSCMH>///</NHSNICMSCMH>
				<Deceased>false</Deceased>
				<SearchedActActivityId>-1</SearchedActActivityId>
				<SearchedActCompleted>0</SearchedActCompleted>
				<SearchedActWithProvider>0</SearchedActWithProvider>
				<OrganisationId>0</OrganisationId>
				<OrganisationName/>
			</Result>
		</NewDataSet>
	</xmlDataSet>
</objManifestingServiceUserSearch>
See Also
All Operations Resource Group | Pro-Cloud API Web Service

 

 

© 2021 All Rights Reserved.

Send comments on this topic.